oracle.olapi.metadata.mtm
Class MtmFirstLastAggregationStep

java.lang.Object
  |
  +--oracle.olapi.metadata.BaseMetadataObject
        |
        +--oracle.olapi.metadata.mtm.MtmObject
              |
              +--oracle.olapi.metadata.mtm.MtmAggregationStep
                    |
                    +--oracle.olapi.metadata.mtm.MtmFirstLastAggregationStep

public class MtmFirstLastAggregationStep

extends MtmAggregationStep

An MtmAggregationStep that specifies that Oracle OLAP use the measure value specified by the first or last child element of the current dimension node element when aggregating measure values specified by a dimension of the MtmAggregationStep.

You can create an instance of this class with the createMtmFirstLastAggregationStep method of an MtmObjectFactory.

Field Summary

static int	FIRST A constant that specifies that Oracle OLAP aggregates the measure value specified by the first child element of the current dimension element.
static int	LAST A constant that specifies that Oracle OLAP aggregates the measure value specified by the last child element of the current dimension element.

Method Summary

java.lang.Object	acceptVisitor(MtmObjectVisitor visitor, java.lang.Object context) Calls the visitMtmFirstLastAggregationStep method of the specified MtmObjectVisitor and passes that method this MtmFirstLastAggregationStep and the specified context object.
int	getAggregationType() Gets the value of the constant that specifies whether Oracle OLAP uses the measure value specified by the first or the last child element of a parent element when aggregating the measure values for the node elements of a dimension.
boolean	isHierarchical() Indicates what Oracle OLAP does if the measure value specified by the child element of the current element of the dimension is null.
void	setAggregationType(int aggregationType) Specifies the value of the constant that determines whether Oracle OLAP uses the measure value specified by the first or the last child element of a parent element when aggregating the measure values for the node elements of a dimension.
void	setIsHierarchical(boolean isHierarchical) Specifies what Oracle OLAP does if the measure value specified by the child element of the current element of the dimension is null.

Methods inherited from class oracle.olapi.metadata.mtm.MtmAggregationStep

addDimensionMap, getDimensionMaps, removeDimensionMap

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIRST

public static final int FIRST

A constant that specifies that Oracle OLAP aggregates the measure value specified by the first child element of the current dimension element.

LAST

public static final int LAST

A constant that specifies that Oracle OLAP aggregates the measure value specified by the last child element of the current dimension element.

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MtmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMtmFirstLastAggregationStep method of the specified MtmObjectVisitor and passes that method this MtmFirstLastAggregationStep and the specified context object.

Overrides:

acceptVisitor in class MtmObject

Parameters:

visitor - An MtmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMtmFirstLastAggregationStep method.

isHierarchical

public boolean isHierarchical()

Indicates what Oracle OLAP does if the measure value specified by the child element of the current element of the dimension is null. If this method returns true, then Oracle OLAP uses the measure value specified by the value of the first or last child element even if that value is null. If the value is null, the result of the aggregation is null. If this method returns false, then Oracle OLAP uses the measure value specified by the closest child element for which the measure is not null.

getAggregationType

public int getAggregationType()

Gets the value of the constant that specifies whether Oracle OLAP uses the measure value specified by the first or the last child element of a parent element when aggregating the measure values for the node elements of a dimension.

Returns:

An int that is the value of the FIRST or LAST field of this MtmFirstLastAggregationStep.

setIsHierarchical

public void setIsHierarchical(boolean isHierarchical)

Specifies what Oracle OLAP does if the measure value specified by the child element of the current element of the dimension is null. Specify true if you want Oracle OLAP to use the measure value specified by the value of the first or last child element even if that value is null. If the value is null, the result of the aggregation is null. Specify false if you want Oracle OLAP to use the measure value specified by the closest child element for which the measure is not null.

setAggregationType

public void setAggregationType(int aggregationType)

Specifies the value of the constant that determines whether Oracle OLAP uses the measure value specified by the first or the last child element of a parent element when aggregating the measure values for the node elements of a dimension.

Returns:

An int that is the value of the FIRST or LAST field of this MtmFirstLastAggregationStep.